| Package | SUPPORT.R4 |
| Type | StructureDefinition |
| Id | Id |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=SUPPORT.R4@3.0.0&canonical=http://phr.kanta.fi/StructureDefinition/fiphr-sd-medicationadministration-r4 |
| Url | http://phr.kanta.fi/StructureDefinition/fiphr-sd-medicationadministration-r4 |
| Version | 0.1 |
| Status | draft |
| Name | FIPHRSDMedicationAdministration |
| Title | Finnish PHR Medication Administration Profile |
| Experimental | True |
| Description | Finnish PHR profile for MedicationAdministration Resource |
| Purpose | Finnish PHR profile describing the event of a patient consuming or otherwise being administered a medication. |
| Type | MedicationAdministration |
| Kind | resource |
No resources found
| StructureDefinition | |
http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication  | Finnish PHR Application Information extension |
| http://phr.kanta.fi/StructureDefinition/fiphr-sd-patient | Finnish PHR Patient profile |
FHIR{
"resourceType" : "StructureDefinition",
"id" : "fiphr-sd-medicationadministration-r4",
"url" : "http://phr.kanta.fi/StructureDefinition/fiphr-sd-medicationadministration-r4",
"version" : "0.1",
"name" : "FIPHRSDMedicationAdministration",
"title" : "Finnish PHR Medication Administration Profile",
"status" : "draft",
"experimental" : true,
"description" : "Finnish PHR profile for MedicationAdministration Resource",
"purpose" : "Finnish PHR profile describing the event of a patient consuming or otherwise being administered a medication.",
"fhirVersion" : "4.0.0",
"kind" : "resource",
"abstract" : false,
"type" : "MedicationAdministration",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "MedicationAdministration",
"path" : "MedicationAdministration",
"short" : "Administration of medication to a patient",
"definition" : "Finnish PHR profile describing the event of a patient consuming or otherwise being administered a medication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "SubstanceAdministration"
}
]
},
{
"id" : "MedicationAdministration.id",
"path" : "MedicationAdministration.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "id"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.meta",
"path" : "MedicationAdministration.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Meta"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.meta.id",
"path" : "MedicationAdministration.meta.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"_code" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString" : "string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString" : "xsd:string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString" : "xsd:string"
}
]
}
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.meta.extension",
"path" : "MedicationAdministration.meta.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.meta.versionId",
"path" : "MedicationAdministration.meta.versionId",
"short" : "Version specific identifier",
"definition" : "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.",
"comment" : "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Meta.versionId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "id"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.meta.lastUpdated",
"path" : "MedicationAdministration.meta.lastUpdated",
"short" : "When the resource version last changed",
"definition" : "When the resource last changed - e.g. when the version changed.",
"comment" : "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http.html#read) interaction.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Meta.lastUpdated",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "instant"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.meta.source",
"path" : "MedicationAdministration.meta.source",
"short" : "Identifies where the resource comes from",
"definition" : "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.",
"comment" : "In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Meta.source",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.meta.profile",
"path" : "MedicationAdministration.meta.profile",
"short" : "Profiles this resource claims to conform to",
"definition" : "A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).",
"comment" : "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Meta.profile",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "canonical",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
],
"fixedCanonical" : "http://phr.kanta.fi/StructureDefinition/fiphr-sd-medicationadministration-r4",
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.meta.security",
"path" : "MedicationAdministration.meta.security",
"short" : "Security Labels applied to this resource",
"definition" : "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"comment" : "The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Meta.security",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"strength" : "extensible",
"description" : "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSet" : "http://hl7.org/fhir/ValueSet/security-labels"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
}
]
},
{
"id" : "MedicationAdministration.meta.tag",
"path" : "MedicationAdministration.meta.tag",
"short" : "Tags applied to this resource",
"definition" : "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"comment" : "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Meta.tag",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"strength" : "example",
"description" : "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\".",
"valueSet" : "http://hl7.org/fhir/ValueSet/common-tags"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
}
]
},
{
"id" : "MedicationAdministration.implicitRules",
"path" : "MedicationAdministration.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.language",
"path" : "MedicationAdministration.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "FinnishPHR: codes from the code system urn:ietf:bcp:47",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"binding" : {
"strength" : "required",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.text",
"path" : "MedicationAdministration.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Narrative"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Act.text?"
}
]
},
{
"id" : "MedicationAdministration.contained",
"path" : "MedicationAdministration.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : [
"inline resources",
"anonymous resources",
"contained resources"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.extension",
"path" : "MedicationAdministration.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.extension:creatingApplication",
"path" : "MedicationAdministration.extension",
"sliceName" : "creatingApplication",
"short" : "Application identification",
"definition" : "Application identification information. SHALL have same values that has been registered for application in PHR application catalog.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : [
"http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.modifierExtension",
"path" : "MedicationAdministration.modifierExtension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.identifier",
"path" : "MedicationAdministration.identifier",
"short" : "External identifier",
"definition" : "A unique identifier assigned to this observation. \r\nFinnish PHR: At least one of the identifiers SHALL be globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system).",
"comment" : "This is a business identifier, not a resource identifier.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"map" : "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
"identity" : "servd",
"map" : "Identifier"
},
{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}
]
},
{
"id" : "MedicationAdministration.identifier.id",
"path" : "MedicationAdministration.identifier.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"_code" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString" : "string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString" : "xsd:string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString" : "xsd:string"
}
]
}
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.identifier.extension",
"path" : "MedicationAdministration.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.identifier.use",
"path" : "MedicationAdministration.identifier.use",
"short" : "usual | official | temp | secondary | old (If known)",
"definition" : "The purpose of this identifier. \r\nFinnish PHR: The code 'official' SHALL be only used if the given identifier value is truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system).",
"comment" : "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary" : true,
"binding" : {
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use|4.0.0"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "MedicationAdministration.identifier.type",
"path" : "MedicationAdministration.identifier.type",
"short" : "Description of identifier",
"definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment" : "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "MedicationAdministration.identifier.system",
"path" : "MedicationAdministration.identifier.system",
"short" : "The namespace for the identifier value",
"definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment" : "Identifier.system is always case sensitive.",
"requirements" : "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "uri"
}
],
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "MedicationAdministration.identifier.value",
"path" : "MedicationAdministration.identifier.value",
"short" : "The value that is unique",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system. \r\nFinnish PHR: At least one of the identifiers SHALL be truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system).",
"comment" : "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "MedicationAdministration.identifier.period",
"path" : "MedicationAdministration.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"comment" : "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Period"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.hasValue().not() or end.hasValue().not() or (start <= end)",
"xpath" : "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "MedicationAdministration.identifier.assigner",
"path" : "MedicationAdministration.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"comment" : "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "MedicationAdministration.instantiates",
"path" : "MedicationAdministration.instantiates",
"short" : "Instantiates protocol or definition",
"definition" : "A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.",
"comment" : "see http://en.wikipedia.org/wiki/Uniform_resource_identifier",
"min" : 0,
"max" : "0",
"base" : {
"path" : "MedicationAdministration.instantiates",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "workflow",
"map" : "Event.instantiates"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target[classCode=unspecified]"
}
]
},
{
"id" : "MedicationAdministration.partOf",
"path" : "MedicationAdministration.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular event is a component or step.",
"comment" : "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "MedicationAdministration.partOf",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"http://hl7.org/fhir/StructureDefinition/Procedure"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP]/target[classCode=SBADM or PROC,moodCode=EVN]"
}
]
},
{
"id" : "MedicationAdministration.status",
"path" : "MedicationAdministration.status",
"short" : "To show that the administration has been completed.",
"definition" : "Will be set to show that the administration has been completed.",
"comment" : "FInnishPHR: Fixed value 'completed'. Only administrations that have been completed are supported in this profile.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.status",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "completed",
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"strength" : "required",
"description" : "A set of codes indicating the current status of a MedicationAdministration.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.0"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "RXA-20-Completion Status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}
]
},
{
"id" : "MedicationAdministration.statusReason",
"path" : "MedicationAdministration.statusReason",
"short" : "Reason administration not performed",
"definition" : "A code indicating why the administration was not performed.",
"comment" : "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "MedicationAdministration.statusReason",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"binding" : {
"strength" : "example",
"description" : "A set of codes indicating the reason why the MedicationAdministration is negated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "workflow",
"map" : "Event.statusReason"
},
{
"identity" : "v2",
"map" : "RXA-9-Administration Notes / RXA-18 Substance/Treatment Refusal Reason"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason not given\"].value"
}
]
},
{
"id" : "MedicationAdministration.category",
"path" : "MedicationAdministration.category",
"short" : "Type of medication usage",
"definition" : "Indicates where the medication is expected to be consumed or administered.",
"comment" : "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "MedicationAdministration.category",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"binding" : {
"strength" : "preferred",
"description" : "A coded concept describing where the medication administered is expected to occur.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-admin-category"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value"
}
]
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept",
"path" : "MedicationAdministration.medication[x]",
"sliceName" : "medicationCodeableConcept",
"short" : "Finnish PHR: VNR coded medication",
"definition" : "FinnishPHR: Identifies the medication that was administered. Code and name of the administered medication.",
"comment" : "Finnish PHR: There are two options for using this field. Option 1: when the medication can be uniquely identified, SHALL be given the VNR code of the medication and the brand name of the medication which SHALL matct match the name in the pharmaceutical database, Option 2: when the medication can not be uniquely identified SHALL be given a text field, entered in medicationCodeableConcept.text.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.medication[x]",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"strength" : "required",
"description" : "Codes identifying substance or product administered.",
"valueSet" : "http://phr.kanta.fi/ValueSet/fiphr-vs-vnrcode"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "RXA-5-Administered Code"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role[classCode=ADMM]"
}
]
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.id",
"path" : "MedicationAdministration.medication[x].id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"_code" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString" : "string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString" : "xsd:string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString" : "xsd:string"
}
]
}
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.extension",
"path" : "MedicationAdministration.medication[x].extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding",
"path" : "MedicationAdministration.medication[x].coding",
"short" : "Finnish PHR: VNR coded medication",
"definition" : "Finnish PHR: VNR coded medication",
"comment" : "Finnish PHR: There are two options for using this field. Option 1: when the medication can be uniquely identified, SHALL be given the VNR code of the medication and the brand name of the medication which SHALL matct match the name in the pharmaceutical database, Option 2: when the medication can not be uniquely identified SHALL be given a text field, entered in medicationCodeableConcept.text.",
"requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeableConcept.coding",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"identity" : "v2",
"map" : "C*E.1-8, C*E.10-22"
},
{
"identity" : "rim",
"map" : "union(., ./translation)"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
}
]
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding.id",
"path" : "MedicationAdministration.medication[x].coding.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"_code" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString" : "string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString" : "xsd:string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString" : "xsd:string"
}
]
}
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding.extension",
"path" : "MedicationAdministration.medication[x].coding.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding.system",
"path" : "MedicationAdministration.medication[x].coding.system",
"short" : "Finnish PHR: VNR code system",
"definition" : "Finnish PHR: VNR code system",
"comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.",
"requirements" : "Need to be unambiguous about the source of the definition of the symbol.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Coding.system",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "urn:oid:1.2.246.537.6.55",
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.3"
},
{
"identity" : "rim",
"map" : "./codeSystem"
},
{
"identity" : "orim",
"map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding.version",
"path" : "MedicationAdministration.medication[x].coding.version",
"short" : "Version of the system - if relevant",
"definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Coding.version",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.7"
},
{
"identity" : "rim",
"map" : "./codeSystemVersion"
},
{
"identity" : "orim",
"map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding.code",
"path" : "MedicationAdministration.medication[x].coding.code",
"short" : "Finnish PHR: VNR code defined by VNR code system",
"definition" : "Finnish PHR: VNR code defined by VNR code system",
"comment" : ".",
"requirements" : "Need to refer to a particular code in the system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Coding.code",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.1"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "orim",
"map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding.display",
"path" : "MedicationAdministration.medication[x].coding.display",
"short" : "Representation defined by the system",
"definition" : "A representation of the meaning of the code in the system, following the rules of the system.",
"comment" : "Note that FHIR strings SHALL NOT exceed 1MB in size",
"requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Coding.display",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.2 - but note this is not well followed"
},
{
"identity" : "rim",
"map" : "CV.displayName"
},
{
"identity" : "orim",
"map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding.userSelected",
"path" : "MedicationAdministration.medication[x].coding.userSelected",
"short" : "If this coding was chosen directly by the user",
"definition" : "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Coding.userSelected",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "boolean"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "Sometimes implied by being first"
},
{
"identity" : "rim",
"map" : "CD.codingRationale"
},
{
"identity" : "orim",
"map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"
}
]
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.text",
"path" : "MedicationAdministration.medication[x].text",
"short" : "Plain text representation of the concept",
"definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"comment" : "Very often the text is the same as a displayName of one of the codings.",
"requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeableConcept.text",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity" : "rim",
"map" : "./originalText[mediaType/code=\"text/plain\"]/data"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
}
]
},
{
"id" : "MedicationAdministration.subject",
"path" : "MedicationAdministration.subject",
"short" : "Who received medication",
"definition" : "The person or animal or group receiving the medication.",
"comment" : "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.subject",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://phr.kanta.fi/StructureDefinition/fiphr-sd-patient"
],
"aggregation" : [
"referenced"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}
]
},
{
"id" : "MedicationAdministration.subject.id",
"path" : "MedicationAdministration.subject.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"_code" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString" : "string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString" : "xsd:string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString" : "xsd:string"
}
]
}
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.subject.extension",
"path" : "MedicationAdministration.subject.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.subject.reference",
"path" : "MedicationAdministration.subject.reference",
"short" : "Literal reference, Relative, internal or absolute URL",
"definition" : "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment" : "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Reference.reference",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1",
"ref-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.subject.type",
"path" : "MedicationAdministration.subject.type",
"short" : "Type the reference refers to (e.g. \"Patient\")",
"definition" : "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment" : "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Reference.type",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"strength" : "extensible",
"description" : "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.subject.identifier",
"path" : "MedicationAdministration.subject.identifier",
"short" : "Logical reference, when literal reference is not known",
"definition" : "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment" : "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Reference.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"map" : "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
"identity" : "servd",
"map" : "Identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
}
]
},
{
"id" : "MedicationAdministration.subject.display",
"path" : "MedicationAdministration.subject.display",
"short" : "Text alternative for the resource",
"definition" : "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment" : "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Reference.display",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.context",
"path" : "MedicationAdministration.context",
"short" : "Encounter or Episode of Care administered as part of",
"definition" : "The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.",
"comment" : "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "MedicationAdministration.context",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1-19-Visit Number"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"
}
]
},
{
"id" : "MedicationAdministration.supportingInformation",
"path" : "MedicationAdministration.supportingInformation",
"short" : "Additional information to support administration",
"definition" : "Additional information (for example, patient height and weight) that supports the administration of the medication.",
"comment" : "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "MedicationAdministration.supportingInformation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"condition" : [
"ele-1"
],
&nb "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "v2",
"map" : "PRT-10 Participation Device / RXR-3 Administrative Device"
},
{
"identity" : "rim",
"map" : "device->Access OR device->AssignedDevice"
}
]
},
{
"id" : "MedicationAdministration.note",
"path" : "MedicationAdministration.note",
"short" : "Information about the administration",
"definition" : "Extra information about the medication administration that is not conveyed by the other attributes.",
"comment" : "For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.note",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Annotation"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Act"
},
{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value"
}
]
},
{
"id" : "MedicationAdministration.note.id",
"path" : "MedicationAdministration.note.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"_code" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString" : "string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString" : "xsd:string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString" : "xsd:string"
}
]
}
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.note.extension",
"path" : "MedicationAdministration.note.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.note.author[x]",
"path" : "MedicationAdministration.note.author[x]",
"short" : "Individual responsible for the annotation",
"definition" : "The individual responsible for making the annotation.",
"comment" : "Organization is used when there's no need for specific attribution as to who made the comment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Annotation.author[x]",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Act.participant[typeCode=AUT].role"
}
]
},
{
"id" : "MedicationAdministration.note.time",
"path" : "MedicationAdministration.note.time",
"short" : "When the annotation was made",
"definition" : "Indicates when this particular annotation was made.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Annotation.time",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "dateTime"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Act.effectiveTime"
}
]
},
{
"id" : "MedicationAdministration.note.text",
"path" : "MedicationAdministration.note.text",
"short" : "The annotation - text content (as markdown)",
"definition" : "The text of the annotation in markdown format.",
"comment" : "Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Annotation.text",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "markdown"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Act.text"
}
]
},
{
"id" : "MedicationAdministration.dosage",
"path" : "MedicationAdministration.dosage",
"short" : "Details of how medication was taken",
"definition" : "Describes the medication dosage information details e.g. dose, rate, site, route, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "mad-1",
"severity" : "error",
"human" : "SHALL have at least one of dosage.dose or dosage.rate[x]",
"expression" : "dose.exists() or rate.exists()",
"xpath" : "exists(f:dose) or exists(f:*[starts-with(local-name(.), 'rate')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "component->SubstanceAdministrationEvent"
}
]
},
{
"id" : "MedicationAdministration.dosage.id",
"path" : "MedicationAdministration.dosage.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"_code" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString" : "string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString" : "xsd:string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString" : "xsd:string"
}
]
}
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.dosage.extension",
"path" : "MedicationAdministration.dosage.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.dosage.modifierExtension",
"path" : "MedicationAdministration.dosage.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.dosage.text",
"path" : "MedicationAdministration.dosage.text",
"short" : "Free text dosage instructions e.g. SIG",
"definition" : "Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.\r\rThe dosage instructions should reflect the dosage of the medication that was administered.",
"comment" : "Note that FHIR strings SHALL NOT exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage.text",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : ".text"
}
]
},
{
"id" : "MedicationAdministration.dosage.site",
"path" : "MedicationAdministration.dosage.site",
"short" : "Body site administered to",
"definition" : "A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\".",
"comment" : ".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage.site",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"binding" : {
"strength" : "required",
"description" : "A coded concept describing the site location the medicine enters into or onto the body.",
"valueSet" : "http://phr.kanta.fi/ValueSet/fiphr-vs-dosagesite"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "RXR-2 Administration Site / RXR-6 Administration Site Modifier"
},
{
"identity" : "rim",
"map" : ".approachSiteCode"
}
]
},
{
"id" : "MedicationAdministration.dosage.site.id",
"path" : "MedicationAdministration.dosage.site.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"_code" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString" : "string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString" : "xsd:string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString" : "xsd:string"
}
]
}
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.dosage.site.extension",
"path" : "MedicationAdministration.dosage.site.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.dosage.site.coding",
"path" : "MedicationAdministration.dosage.site.coding",
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeableConcept.coding",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"identity" : "v2",
"map" : "C*E.1-8, C*E.10-22"
},
{
"identity" : "rim",
"map" : "union(., ./translation)"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
}
]
},
{
"id" : "MedicationAdministration.dosage.site.coding.id",
"path" : "MedicationAdministration.dosage.site.coding.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"_code" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString" : "string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString" : "xsd:string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString" : "xsd:string"
}
]
}
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "MedicationAdministration.dosage.site.coding.extension",
"path" : "MedicationAdministration.dosage.site.coding.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "MedicationAdministration.dosage.site.coding.system",
"path" : "MedicationAdministration.dosage.site.coding.system",
"short" : "Identity of the terminology system",
"definition" : "The identification of the code system that defines the meaning of the symbol in the code.",
"comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.",
"requirements" : "Need to be unambiguous about the source of the definition of the symbol.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Coding.system",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "urn:oid:1.2.246.537.5.163",
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.3"
},
{
"identity" : "rim",
"map" : "./codeSystem"
},
{
"identity" : "orim",
"map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id" : "MedicationAdministration.dosage.site.coding.version",
"path" : "MedicationAdministration.dosage.site.coding.version",
"short" : "Version of the system - if relevant",
"definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Coding.version",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.7"
},
{
"identity" : "rim",
"map" : "./codeSystemVersion"
},
{
"identity" : "orim",
"map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id" : "MedicationAdministration.dosage.site.coding.code",
"path" : "MedicationAdministration.dosage.site.coding.code",
"short" : "Symbol in syntax defined by the system",
"definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"comment" : "Note that FHIR strings SHALL NOT exceed 1MB in size",
"requirements" : "Need to refer to a particular code in the system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Coding.code",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.1"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "orim",
"map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id" : "MedicationAdministration.dosage.site.coding.display",
"path" : "MedicationAdministration.dosage.site.coding.display",
"short" : "Representation defined by the system",
"definition" : "A representation of the meaning of the code in the system, following the rules of the system.",
"comment" : "Note that FHIR strings SHALL NOT exceed 1MB in size",
"requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Coding.display",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.2 - but note this is not well followed"
},
{
"identity" : "rim",
"map" : "CV.displayName"
},
{
"identity" : "orim",
"map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id" : "MedicationAdministration.dosage.site.coding.userSelected",
"path" : "MedicationAdministration.dosage.site.coding.userSelected",
"short" : "If this coding was chosen directly by the user",
"definition" : "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Coding.userSelected",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "boolean"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "Sometimes implied by being first"
},
{
"identity" : "rim",
"map" : "CD.codingRationale"
},
{
"identity" : "orim",
"map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"
}
]
},
{
"id" : "MedicationAdministration.dosage.site.text",
"path" : "MedicationAdministration.dosage.site.text",
"short" : "Plain text representation of the concept",
"definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"comment" : "Very often the text is the same as a displayName of one of the codings.",
"requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeableConcept.text",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity" : "rim",
"map" : "./originalText[mediaType/code=\"text/plain\"]/data"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
}
]
},
{
"id" : "MedicationAdministration.dosage.route",
"path" : "MedicationAdministration.dosage.route",
"short" : "Path of substance into body",
"definition" : "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.",
"comment" : "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "MedicationAdministration.dosage.route",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"binding" : {
"strength" : "example",
"description" : "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSet" : "http://hl7.org/fhir/ValueSet/route-codes"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "RXR-1-Route"
},
{
"identity" : "rim",
"map" : ".routeCode"
}
]
},
{
"id" : "MedicationAdministration.dosage.method",
"path" : "MedicationAdministration.dosage.method",
"short" : "How drug was administered",
"definition" : "A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.",
"comment" : "One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "MedicationAdministration.dosage.method",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"binding" : {
"strength" : "example",
"description" : "A coded concept describing the technique by which the medicine is administered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administration-method-codes"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "RXR-4-Administration Method"
},
{
"identity" : "rim",
"map" : ".methodCode"
}
]
},
{
"id" : "MedicationAdministration.dosage.dose",
"path" : "MedicationAdministration.dosage.dose",
"short" : "Amount of medication per dose",
"definition" : "The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.",
"comment" : "If the administration is not instantaneous (rate is present), this can be specified to convey the total amount administered over period of time of a single administration.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage.dose",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Quantity",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "qty-3",
"severity" : "error",
"human" : "If a code for the unit is present, the system SHALL also be present",
"expression" : "code.empty() or system.exists()",
"xpath" : "not(exists(f:code)) or exists(f:system)"
},
{
"key" : "sqty-1",
"severity" : "error",
"human" : "The comparator is not used on a SimpleQuantity",
"expression" : "comparator.empty()",
"xpath" : "not(exists(f:comparator))"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "SN (see also Range) or CQ"
},
{
"identity" : "rim",
"map" : "PQ, IVL<PQ>, MO, CO, depending on the values"
},
{
"identity" : "v2",
"map" : "RXA-6 Administered Amount / RXA-7 Administered Units"
},
{
"identity" : "rim",
"map" : ".doseQuantity"
}
]
},
{
"id" : "MedicationAdministration.dosage.rate[x]",
"path" : "MedicationAdministration.dosage.rate[x]",
"short" : "Dose quantity per unit of time",
"definition" : "Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.",
"comment" : "If the rate changes over time, and you want to capture this in MedicationAdministration, then each change should be captured as a distinct MedicationAdministration, with a specific MedicationAdministration.dosage.rate, and the date time when the rate change occurred. Typically, the MedicationAdministration.dosage.rate element is not used to convey an average rate.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage.rate[x]",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Ratio"
},
{
"code" : "Quantity",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "rat-1",
"severity" : "error",
"human" : "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present",
"expression" : "(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())",
"xpath" : "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "RTO"
},
{
"identity" : "v2",
"map" : "RXA-12-Administered Per (Time Unit)"
},
{
"identity" : "rim",
"map" : ".rateQuantity"
}
]
},
{
"id" : "MedicationAdministration.eventHistory",
"path" : "MedicationAdministration.eventHistory",
"short" : "A list of events of interest in the lifecycle",
"definition" : "A summary of the events of interest that have occurred, such as when the administration was verified.",
"comment" : "This might not include provenances for all versions of the request – only those deemed “relevant†or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant†change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "MedicationAdministration.eventHistory",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Provenance"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "MedicationAdministration",
"path" : "MedicationAdministration",
"definition" : "Finnish PHR profile describing the event of a patient consuming or otherwise being administered a medication."
},
{
"id" : "MedicationAdministration.meta.profile",
"path" : "MedicationAdministration.meta.profile",
"min" : 1,
"max" : "1",
"fixedCanonical" : "http://phr.kanta.fi/StructureDefinition/fiphr-sd-medicationadministration-r4"
},
{
"id" : "MedicationAdministration.language",
"path" : "MedicationAdministration.language",
"definition" : "The base language in which the resource is written.",
"comment" : "FinnishPHR: codes from the code system urn:ietf:bcp:47",
"min" : 1,
"binding" : {
"strength" : "required"
}
},
{
"id" : "MedicationAdministration.text",
"path" : "MedicationAdministration.text",
"min" : 1
},
{
"id" : "MedicationAdministration.extension",
"path" : "MedicationAdministration.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"rules" : "open"
}
},
{
"id" : "MedicationAdministration.extension:creatingApplication",
"path" : "MedicationAdministration.extension",
"sliceName" : "creatingApplication",
"type" : [
{
"code" : "Extension",
"profile" : [
"http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication"
]
}
]
},
{
"id" : "MedicationAdministration.identifier",
"path" : "MedicationAdministration.identifier",
"definition" : "A unique identifier assigned to this observation. \r\nFinnish PHR: At least one of the identifiers SHALL be globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system).",
"min" : 1
},
{
"id" : "MedicationAdministration.identifier.use",
"path" : "MedicationAdministration.identifier.use",
"definition" : "The purpose of this identifier. \r\nFinnish PHR: The code 'official' SHALL be only used if the given identifier value is truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system)."
},
{
"id" : "MedicationAdministration.identifier.type",
"path" : "MedicationAdministration.identifier.type",
"max" : "0"
},
{
"id" : "MedicationAdministration.identifier.system",
"path" : "MedicationAdministration.identifier.system",
"min" : 1
},
{
"id" : "MedicationAdministration.identifier.value",
"path" : "MedicationAdministration.identifier.value",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system. \r\nFinnish PHR: At least one of the identifiers SHALL be truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system).",
"min" : 1
},
{
"id" : "MedicationAdministration.identifier.period",
"path" : "MedicationAdministration.identifier.period",
"max" : "0"
},
{
"id" : "MedicationAdministration.identifier.assigner",
"path" : "MedicationAdministration.identifier.assigner",
"max" : "0"
},
{
"id" : "MedicationAdministration.instantiates",
"path" : "MedicationAdministration.instantiates",
"max" : "0"
},
{
"id" : "MedicationAdministration.partOf",
"path" : "MedicationAdministration.partOf",
"max" : "0"
},
{
"id" : "MedicationAdministration.status",
"path" : "MedicationAdministration.status",
"short" : "To show that the administration has been completed.",
"definition" : "Will be set to show that the administration has been completed.",
"comment" : "FInnishPHR: Fixed value 'completed'. Only administrations that have been completed are supported in this profile.",
"fixedCode" : "completed"
},
{
"id" : "MedicationAdministration.statusReason",
"path" : "MedicationAdministration.statusReason",
"max" : "0"
},
{
"id" : "MedicationAdministration.category",
"path" : "MedicationAdministration.category",
"max" : "0"
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept",
"path" : "MedicationAdministration.medication[x]",
"sliceName" : "medicationCodeableConcept",
"short" : "Finnish PHR: VNR coded medication",
"definition" : "FinnishPHR: Identifies the medication that was administered. Code and name of the administered medication.",
"comment" : "Finnish PHR: There are two options for using this field. Option 1: when the medication can be uniquely identified, SHALL be given the VNR code of the medication and the brand name of the medication which SHALL matct match the name in the pharmaceutical database, Option 2: when the medication can not be uniquely identified SHALL be given a text field, entered in medicationCodeableConcept.text.",
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "required",
"description" : "Codes identifying substance or product administered.",
"valueSet" : "http://phr.kanta.fi/ValueSet/fiphr-vs-vnrcode"
}
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding",
"path" : "MedicationAdministration.medication[x].coding",
"short" : "Finnish PHR: VNR coded medication",
"definition" : "Finnish PHR: VNR coded medication",
"comment" : "Finnish PHR: There are two options for using this field. Option 1: when the medication can be uniquely identified, SHALL be given the VNR code of the medication and the brand name of the medication which SHALL matct match the name in the pharmaceutical database, Option 2: when the medication can not be uniquely identified SHALL be given a text field, entered in medicationCodeableConcept.text."
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding.system",
"path" : "MedicationAdministration.medication[x].coding.system",
"short" : "Finnish PHR: VNR code system",
"definition" : "Finnish PHR: VNR code system",
"min" : 1,
"fixedUri" : "urn:oid:1.2.246.537.6.55"
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding.version",
"path" : "MedicationAdministration.medication[x].coding.version",
"max" : "0"
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding.code",
"path" : "MedicationAdministration.medication[x].coding.code",
"short" : "Finnish PHR: VNR code defined by VNR code system",
"definition" : "Finnish PHR: VNR code defined by VNR code system",
"comment" : ".",
"min" : 1
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding.display",
"path" : "MedicationAdministration.medication[x].coding.display",
"min" : 1
},
{
"id" : "MedicationAdministration.medication[x]:medicationCodeableConcept.coding.userSelected",
"path" : "MedicationAdministration.medication[x].coding.userSelected",
"max" : "0"
},
{
"id" : "MedicationAdministration.subject",
"path" : "MedicationAdministration.subject",
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://phr.kanta.fi/StructureDefinition/fiphr-sd-patient"
],
"aggregation" : [
"referenced"
]
}
]
},
{
"id" : "MedicationAdministration.subject.reference",
"path" : "MedicationAdministration.subject.reference",
"min" : 1
},
{
"id" : "MedicationAdministration.subject.type",
"path" : "MedicationAdministration.subject.type",
"max" : "0"
},
{
"id" : "MedicationAdministration.subject.identifier",
"path" : "MedicationAdministration.subject.identifier",
"max" : "0"
},
{
"id" : "MedicationAdministration.subject.display",
"path" : "MedicationAdministration.subject.display",
"max" : "0"
},
{
"id" : "MedicationAdministration.context",
"path" : "MedicationAdministration.context",
"max" : "0"
},
{
"id" : "MedicationAdministration.supportingInformation",
"path" : "MedicationAdministration.supportingInformation",
"max" : "0"
},
{
"id" : "MedicationAdministration.effective[x]:effectiveDateTime",
"path" : "MedicationAdministration.effective[x]",
"sliceName" : "effectiveDateTime",
"short" : "FinnishPHR: Time of administration",
"definition" : "FinnishPHR: A specific time of time during which the administration took place.",
"type" : [
{
"code" : "dateTime"
}
]
},
{
"id" : "MedicationAdministration.performer.function",
"path" : "MedicationAdministration.performer.function",
"max" : "0"
},
{
"id" : "MedicationAdministration.performer.actor",
"path" : "MedicationAdministration.performer.actor",
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://phr.kanta.fi/StructureDefinition/fiphr-sd-patient"
],
"aggregation" : [
"referenced"
]
}
]
},
{
"id" : "MedicationAdministration.performer.actor.reference",
"path" : "MedicationAdministration.performer.actor.reference",
"min" : 1
},
{
"id" : "MedicationAdministration.performer.actor.identifier",
"path" : "MedicationAdministration.performer.actor.identifier",
"max" : "0"
},
{
"id" : "MedicationAdministration.performer.actor.display",
"path" : "MedicationAdministration.performer.actor.display",
"max" : "0"
},
{
"id" : "MedicationAdministration.reasonCode",
"path" : "MedicationAdministration.reasonCode",
"max" : "0"
},
{
"id" : "MedicationAdministration.reasonReference",
"path" : "MedicationAdministration.reasonReference",
"max" : "0"
},
{
"id" : "MedicationAdministration.request",
"path" : "MedicationAdministration.request",
"max" : "0"
},
{
"id" : "MedicationAdministration.note",
"path" : "MedicationAdministration.note",
"comment" : "For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time."
},
{
"id" : "MedicationAdministration.note.author[x]",
"path" : "MedicationAdministration.note.author[x]",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "MedicationAdministration.dosage.site",
"path" : "MedicationAdministration.dosage.site",
"comment" : ".",
"binding" : {
"strength" : "required",
"valueSet" : "http://phr.kanta.fi/ValueSet/fiphr-vs-dosagesite"
}
},
{
"id" : "MedicationAdministration.dosage.site.coding.system",
"path" : "MedicationAdministration.dosage.site.coding.system",
"min" : 1,
"fixedUri" : "urn:oid:1.2.246.537.5.163"
},
{
"id" : "MedicationAdministration.dosage.site.coding.version",
"path" : "MedicationAdministration.dosage.site.coding.version",
"max" : "0"
},
{
"id" : "MedicationAdministration.dosage.site.coding.code",
"path" : "MedicationAdministration.dosage.site.coding.code",
"min" : 1
},
{
"id" : "MedicationAdministration.dosage.site.coding.display",
"path" : "MedicationAdministration.dosage.site.coding.display",
"min" : 1
},
{
"id" : "MedicationAdministration.dosage.site.coding.userSelected",
"path" : "MedicationAdministration.dosage.site.coding.userSelected",
"max" : "0"
},
{
"id" : "MedicationAdministration.dosage.route",
"path" : "MedicationAdministration.dosage.route",
"max" : "0"
},
{
"id" : "MedicationAdministration.dosage.method",
"path" : "MedicationAdministration.dosage.method",
"max" : "0"
},
{
"id" : "MedicationAdministration.eventHistory",
"path" : "MedicationAdministration.eventHistory",
"max" : "0"
}
]
},
"text" : {
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.